<!DOCTYPE html>
<html lang="en">
  <head>
    <title>Coordinator Protocol Reference</title>
    <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
    <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
    <meta charset="utf-8">
    <script src="../js/jquery.min.js" defer></script>
    <script src="../js/jazzy.js" defer></script>
    
    <script src="../js/lunr.min.js" defer></script>
    <script src="../js/typeahead.jquery.js" defer></script>
    <script src="../js/jazzy.search.js" defer></script>
  </head>
  <body>

    <a name="//apple_ref/swift/Protocol/Coordinator" class="dashAnchor"></a>

    <a title="Coordinator Protocol Reference"></a>

    <header class="header">
      <p class="header-col header-col--primary">
        <a class="header-link" href="../index.html">
          XCoordinator Docs
        </a>
        
      </p>
    
      <p class="header-col--secondary">
        <form role="search" action="../search.json">
          <input type="text" placeholder="Search documentation" data-typeahead>
        </form>
      </p>
    
        <p class="header-col header-col--secondary">
          <a class="header-link" href="https://github.com/quickbirdstudios/XCoordinator">
            <img class="header-icon" src="../img/gh.png"/>
            View on GitHub
          </a>
        </p>
    
    </header>

    <p class="breadcrumbs">
      <a class="breadcrumb" href="../index.html">XCoordinator Reference</a>
      <img class="carat" src="../img/carat.png" />
      Coordinator Protocol Reference
    </p>

    <div class="content-wrapper">
      <nav class="navigation">
        <ul class="nav-groups">
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="../Classes.html">Classes</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/Animation.html">Animation</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/AnyCoordinator.html">AnyCoordinator</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/AnyTransitionPerformer.html">AnyTransitionPerformer</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/BaseCoordinator.html">BaseCoordinator</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/BasicCoordinator.html">BasicCoordinator</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/BasicCoordinator/InitialLoadingType.html">– InitialLoadingType</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/InteractiveTransitionAnimation.html">InteractiveTransitionAnimation</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/InterruptibleTransitionAnimation.html">InterruptibleTransitionAnimation</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/NavigationAnimationDelegate.html">NavigationAnimationDelegate</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/NavigationCoordinator.html">NavigationCoordinator</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/PageCoordinator.html">PageCoordinator</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/PageCoordinatorDataSource.html">PageCoordinatorDataSource</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/RedirectionRouter.html">RedirectionRouter</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/SplitCoordinator.html">SplitCoordinator</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/StaticTransitionAnimation.html">StaticTransitionAnimation</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/StrongRouter.html">StrongRouter</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/TabBarAnimationDelegate.html">TabBarAnimationDelegate</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/TabBarCoordinator.html">TabBarCoordinator</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/ViewCoordinator.html">ViewCoordinator</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Extensions/UIView.html">UIView</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Extensions/UIViewController.html">UIViewController</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Protocols/Container.html">Container</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Protocols/Coordinator.html">Coordinator</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Protocols/PercentDrivenInteractionController.html">PercentDrivenInteractionController</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Protocols/Presentable.html">Presentable</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Protocols.html#/s:12XCoordinator5RouteP">Route</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Protocols/Router.html">Router</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Protocols/TransitionAnimation.html">TransitionAnimation</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Protocols/TransitionContext.html">TransitionContext</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Protocols/TransitionPerformer.html">TransitionPerformer</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Protocols/TransitionProtocol.html">TransitionProtocol</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="../Structs.html">Structures</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/Transition.html">Transition</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/TransitionOptions.html">TransitionOptions</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/UnownedErased.html">UnownedErased</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/UnownedErased.html">UnownedErased</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/WeakErased.html">WeakErased</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/WeakErased.html">WeakErased</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:12XCoordinator24AnyNavigationCoordinatora">AnyNavigationCoordinator</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:12XCoordinator9AnyRoutera">AnyRouter</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:12XCoordinator20AnyTabBarCoordinatora">AnyTabBarCoordinator</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:12XCoordinator18AnyViewCoordinatora">AnyViewCoordinator</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:12XCoordinator26BasicNavigationCoordinatora">BasicNavigationCoordinator</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:12XCoordinator22BasicTabBarCoordinatora">BasicTabBarCoordinator</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:12XCoordinator20BasicViewCoordinatora">BasicViewCoordinator</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:12XCoordinator26ContextPresentationHandlera">ContextPresentationHandler</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:12XCoordinator20NavigationTransitiona">NavigationTransition</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:12XCoordinator14PageTransitiona">PageTransition</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:12XCoordinator19PresentationHandlera">PresentationHandler</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:12XCoordinator15SplitTransitiona">SplitTransition</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:12XCoordinator16TabBarTransitiona">TabBarTransition</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:12XCoordinator13UnownedRoutera">UnownedRouter</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:12XCoordinator14ViewTransitiona">ViewTransition</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:12XCoordinator10WeakRoutera">WeakRouter</a>
              </li>
            </ul>
          </li>
        </ul>
      </nav>
      <article class="main-content">

        <section class="section">
          <div class="section-content">
            <h1>Coordinator</h1>
              <div class="declaration">
                <div class="language">
                  <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">Coordinator</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/Router.html">Router</a></span><span class="p">,</span> <span class="kt"><a href="../Protocols/TransitionPerformer.html">TransitionPerformer</a></span></code></pre>

                </div>
              </div>
            <p>Coordinator is the protocol every coordinator conforms to.</p>

<p>It requires an object to be able to trigger routes and perform transitions.
This connection is created using the <code>prepareTransition(for:)</code> method.</p>

          </div>
        </section>

        <section class="section">
          <div class="section-content">
            <div class="task-group">
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12XCoordinator11CoordinatorP17prepareTransition3for0D4TypeQz05RouteF0Qz_tF"></a>
                    <a name="//apple_ref/swift/Method/prepareTransition(for:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:12XCoordinator11CoordinatorP17prepareTransition3for0D4TypeQz05RouteF0Qz_tF">prepareTransition(for:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>This method prepares transitions for routes.
It especially decides, which transitions are performed for the triggered routes.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">prepareTransition</span><span class="p">(</span><span class="k">for</span> <span class="nv">route</span><span class="p">:</span> <span class="kt">RouteType</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">TransitionType</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>route</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The triggered route for which a transition is to be prepared.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>The prepared transition.</p>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12XCoordinator11CoordinatorP8addChildyyAA11Presentable_pF"></a>
                    <a name="//apple_ref/swift/Method/addChild(_:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:12XCoordinator11CoordinatorP8addChildyyAA11Presentable_pF">addChild(_:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>This method adds a child to a coordinator&rsquo;s children.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">addChild</span><span class="p">(</span><span class="n">_</span> <span class="nv">presentable</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Presentable.html">Presentable</a></span><span class="p">)</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>presentable</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The child to be added.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12XCoordinator11CoordinatorP11removeChildyyAA11Presentable_pF"></a>
                    <a name="//apple_ref/swift/Method/removeChild(_:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:12XCoordinator11CoordinatorP11removeChildyyAA11Presentable_pF">removeChild(_:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>This method removes a child to a coordinator&rsquo;s children.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">removeChild</span><span class="p">(</span><span class="n">_</span> <span class="nv">presentable</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Presentable.html">Presentable</a></span><span class="p">)</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>presentable</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The child to be removed.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12XCoordinator11CoordinatorP22removeChildrenIfNeededyyF"></a>
                    <a name="//apple_ref/swift/Method/removeChildrenIfNeeded()" class="dashAnchor"></a>
                    <a class="token" href="#/s:12XCoordinator11CoordinatorP22removeChildrenIfNeededyyF">removeChildrenIfNeeded()</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>This method removes all children that are no longer in the view hierarchy.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">removeChildrenIfNeeded</span><span class="p">()</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Typealiases"></a>
                <a name="//apple_ref/swift/Section/Typealiases" class="dashAnchor"></a>
                <a href="#/Typealiases">
                  <h3 class="section-name">Typealiases</h3>
                </a>
              </div>
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12XCoordinator11CoordinatorPAAE18RootViewControllera"></a>
                    <a name="//apple_ref/swift/Alias/RootViewController" class="dashAnchor"></a>
                    <a class="token" href="#/s:12XCoordinator11CoordinatorPAAE18RootViewControllera">RootViewController</a>
                    </code>
                      <span class="declaration-note">
                        Extension method
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Shortcut for Coordinator.TransitionType.RootViewController</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">RootViewController</span> <span class="o">=</span> <span class="kt">TransitionType</span><span class="o">.</span><span class="kt">RootViewController</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Presentable"></a>
                <a name="//apple_ref/swift/Section/Presentable" class="dashAnchor"></a>
                <a href="#/Presentable">
                  <h3 class="section-name">Presentable</h3>
                </a>
              </div>
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12XCoordinator11CoordinatorPAAE14viewControllerSo06UIViewD0CSgvp"></a>
                    <a name="//apple_ref/swift/Property/viewController" class="dashAnchor"></a>
                    <a class="token" href="#/s:12XCoordinator11CoordinatorPAAE14viewControllerSo06UIViewD0CSgvp">viewController</a>
                    </code>
                      <span class="declaration-note">
                        Extension method
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>A Coordinator uses its rootViewController as viewController.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">viewController</span><span class="p">:</span> <span class="kt">UIViewController</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Presentable2"></a>
                <a name="//apple_ref/swift/Section/Presentable" class="dashAnchor"></a>
                <a href="#/Presentable2">
                  <h3 class="section-name">Presentable</h3>
                </a>
              </div>
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12XCoordinator11CoordinatorPAARlzCrlE10weakRouterAA10WeakErasedVyAA06StrongD0Cy9RouteTypeQzGGvp"></a>
                    <a name="//apple_ref/swift/Property/weakRouter" class="dashAnchor"></a>
                    <a class="token" href="#/s:12XCoordinator11CoordinatorPAARlzCrlE10weakRouterAA10WeakErasedVyAA06StrongD0Cy9RouteTypeQzGGvp">weakRouter</a>
                    </code>
                      <span class="declaration-note">
                        Extension method
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Creates a WeakRouter object from the given router to abstract from concrete implementations
while maintaining information necessary to fulfill the Router protocol.
The original router will be held weakly.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">weakRouter</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:12XCoordinator10WeakRoutera">WeakRouter</a></span><span class="o">&lt;</span><span class="kt">RouteType</span><span class="o">&gt;</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12XCoordinator11CoordinatorPAARlzCrlE13unownedRouterAA13UnownedErasedVyAA06StrongD0Cy9RouteTypeQzGGvp"></a>
                    <a name="//apple_ref/swift/Property/unownedRouter" class="dashAnchor"></a>
                    <a class="token" href="#/s:12XCoordinator11CoordinatorPAARlzCrlE13unownedRouterAA13UnownedErasedVyAA06StrongD0Cy9RouteTypeQzGGvp">unownedRouter</a>
                    </code>
                      <span class="declaration-note">
                        Extension method
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Creates an UnownedRouter object from the given router to abstract from concrete implementations
while maintaining information necessary to fulfill the Router protocol.
The original router will be held unowned.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">unownedRouter</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:12XCoordinator13UnownedRoutera">UnownedRouter</a></span><span class="o">&lt;</span><span class="kt">RouteType</span><span class="o">&gt;</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Default%20implementations"></a>
                <a name="//apple_ref/swift/Section/Default implementations" class="dashAnchor"></a>
                <a href="#/Default%20implementations">
                  <h3 class="section-name">Default implementations</h3>
                </a>
              </div>
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12XCoordinator11CoordinatorPAARlzCrlE03anyB0AA03AnyB0Cy9RouteTypeQz010TransitionF0QzGvp"></a>
                    <a name="//apple_ref/swift/Property/anyCoordinator" class="dashAnchor"></a>
                    <a class="token" href="#/s:12XCoordinator11CoordinatorPAARlzCrlE03anyB0AA03AnyB0Cy9RouteTypeQz010TransitionF0QzGvp">anyCoordinator</a>
                    </code>
                      <span class="declaration-note">
                        Extension method
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Creates an AnyCoordinator based on the current coordinator.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">anyCoordinator</span><span class="p">:</span> <span class="kt"><a href="../Classes/AnyCoordinator.html">AnyCoordinator</a></span><span class="o">&lt;</span><span class="kt">RouteType</span><span class="p">,</span> <span class="kt">TransitionType</span><span class="o">&gt;</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12XCoordinator11PresentableP9presented4fromyAaB_pSg_tF"></a>
                    <a name="//apple_ref/swift/Method/presented(from:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:12XCoordinator11PresentableP9presented4fromyAaB_pSg_tF">presented(from:)</a>
                    </code>
                      <span class="declaration-note">
                        Extension method
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">presented</span><span class="p">(</span><span class="n">from</span> <span class="nv">presentable</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Presentable.html">Presentable</a></span><span class="p">?)</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12XCoordinator11PresentableP24childTransitionCompletedyyF"></a>
                    <a name="//apple_ref/swift/Method/childTransitionCompleted()" class="dashAnchor"></a>
                    <a class="token" href="#/s:12XCoordinator11PresentableP24childTransitionCompletedyyF">childTransitionCompleted()</a>
                    </code>
                      <span class="declaration-note">
                        Extension method
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">childTransitionCompleted</span><span class="p">()</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12XCoordinator11CoordinatorPAARlzCrlE14contextTrigger_4with10completiony9RouteTypeQz_AA17TransitionOptionsVyAA0I7Context_pcSgtF"></a>
                    <a name="//apple_ref/swift/Method/contextTrigger(_:with:completion:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:12XCoordinator11CoordinatorPAARlzCrlE14contextTrigger_4with10completiony9RouteTypeQz_AA17TransitionOptionsVyAA0I7Context_pcSgtF">contextTrigger(_:with:completion:)</a>
                    </code>
                      <span class="declaration-note">
                        Extension method
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">contextTrigger</span><span class="p">(</span><span class="n">_</span> <span class="nv">route</span><span class="p">:</span> <span class="kt">RouteType</span><span class="p">,</span>
                           <span class="n">with</span> <span class="nv">options</span><span class="p">:</span> <span class="kt"><a href="../Structs/TransitionOptions.html">TransitionOptions</a></span><span class="p">,</span>
                           <span class="nv">completion</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:12XCoordinator26ContextPresentationHandlera">ContextPresentationHandler</a></span><span class="p">?)</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12XCoordinator11CoordinatorPAARlzCrlE5chain6routes14TransitionTypeQzSay05RouteF0QzG_tF"></a>
                    <a name="//apple_ref/swift/Method/chain(routes:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:12XCoordinator11CoordinatorPAARlzCrlE5chain6routes14TransitionTypeQzSay05RouteF0QzG_tF">chain(routes:)</a>
                    </code>
                      <span class="declaration-note">
                        Extension method
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>With <code>chain(routes:)</code> different routes can be chained together to form a combined transition.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">chain</span><span class="p">(</span><span class="nv">routes</span><span class="p">:</span> <span class="p">[</span><span class="kt">RouteType</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="kt">TransitionType</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>routes</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The routes to be chained.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>A transition combining the transitions of the specified routes.</p>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12XCoordinator19TransitionPerformerP07performB0_4with10completiony0B4TypeQz_AA0B7OptionsVyycSgtF"></a>
                    <a name="//apple_ref/swift/Method/performTransition(_:with:completion:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:12XCoordinator19TransitionPerformerP07performB0_4with10completiony0B4TypeQz_AA0B7OptionsVyycSgtF">performTransition(_:with:completion:)</a>
                    </code>
                      <span class="declaration-note">
                        Extension method
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">performTransition</span><span class="p">(</span><span class="n">_</span> <span class="nv">transition</span><span class="p">:</span> <span class="kt">TransitionType</span><span class="p">,</span>
                              <span class="n">with</span> <span class="nv">options</span><span class="p">:</span> <span class="kt"><a href="../Structs/TransitionOptions.html">TransitionOptions</a></span><span class="p">,</span>
                              <span class="nv">completion</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:12XCoordinator19PresentationHandlera">PresentationHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Coordinator%20+%20DeepLinking"></a>
                <a name="//apple_ref/swift/Section/Coordinator + DeepLinking" class="dashAnchor"></a>
                <a href="#/Coordinator%20+%20DeepLinking">
                  <h3 class="section-name">Coordinator + DeepLinking</h3>
                </a>
              </div>
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12XCoordinator11CoordinatorPAARlzCrlE8deepLinkyAA10TransitionVyqd__G9RouteTypeQz_qd_0_tSo16UIViewControllerCRbd__STRd_0_AG0eG0RtzAA0F0_p7ElementRtd_0_r0_lF"></a>
                    <a name="//apple_ref/swift/Method/deepLink(_:_:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:12XCoordinator11CoordinatorPAARlzCrlE8deepLinkyAA10TransitionVyqd__G9RouteTypeQz_qd_0_tSo16UIViewControllerCRbd__STRd_0_AG0eG0RtzAA0F0_p7ElementRtd_0_r0_lF">deepLink(_:_:)</a>
                    </code>
                      <span class="declaration-note">
                        Extension method
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Deep-Linking can be used to chain routes of different types together.</p>
<div class="aside aside-note">
    <p class="aside-title">Note</p>
    <p>Use it with caution, as it is not implemented in a type-safe manner.
Keep in mind that changes in the app&rsquo;s structure and changes of transitions
behind the given routes can lead to runtime errors and, therefore, crashes of your app.</p>

</div>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">deepLink</span><span class="o">&lt;</span><span class="kt"><a href="../Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorPAAE18RootViewControllera">RootViewController</a></span><span class="p">,</span> <span class="kt">S</span><span class="p">:</span> <span class="kt">Sequence</span><span class="o">&gt;</span><span class="p">(</span><span class="n">_</span> <span class="nv">route</span><span class="p">:</span> <span class="kt">RouteType</span><span class="p">,</span> <span class="n">_</span> <span class="nv">remainingRoutes</span><span class="p">:</span> <span class="kt">S</span><span class="p">)</span>
    <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/Transition.html">Transition</a></span><span class="o">&lt;</span><span class="kt"><a href="../Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorPAAE18RootViewControllera">RootViewController</a></span><span class="o">&gt;</span> <span class="k">where</span> <span class="kt">S</span><span class="o">.</span><span class="kt">Element</span> <span class="o">==</span> <span class="kt"><a href="../Protocols.html#/s:12XCoordinator5RouteP">Route</a></span><span class="p">,</span> <span class="kt">TransitionType</span> <span class="o">==</span> <span class="kt"><a href="../Structs/Transition.html">Transition</a></span><span class="o">&lt;</span><span class="kt"><a href="../Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorPAAE18RootViewControllera">RootViewController</a></span><span class="o">&gt;</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>route</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The first route in the chain.
It is given a special place because its exact type can be specified.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>remainingRoutes</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The remaining routes of the chain.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12XCoordinator11CoordinatorPAARlzCrlE8deepLinkyAA10TransitionVyqd__G9RouteTypeQz_AA0F0_pdtSo16UIViewControllerCRbd__AG0eG0RtzlF"></a>
                    <a name="//apple_ref/swift/Method/deepLink(_:_:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:12XCoordinator11CoordinatorPAARlzCrlE8deepLinkyAA10TransitionVyqd__G9RouteTypeQz_AA0F0_pdtSo16UIViewControllerCRbd__AG0eG0RtzlF">deepLink(_:_:)</a>
                    </code>
                      <span class="declaration-note">
                        Extension method
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Deep-Linking can be used to chain routes of different types together.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">deepLink</span><span class="o">&lt;</span><span class="kt"><a href="../Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorPAAE18RootViewControllera">RootViewController</a></span><span class="o">&gt;</span><span class="p">(</span><span class="n">_</span> <span class="nv">route</span><span class="p">:</span> <span class="kt">RouteType</span><span class="p">,</span> <span class="n">_</span> <span class="nv">remainingRoutes</span><span class="p">:</span> <span class="kt"><a href="../Protocols.html#/s:12XCoordinator5RouteP">Route</a></span><span class="o">...</span><span class="p">)</span>
    <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/Transition.html">Transition</a></span><span class="o">&lt;</span><span class="kt"><a href="../Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorPAAE18RootViewControllera">RootViewController</a></span><span class="o">&gt;</span> <span class="k">where</span> <span class="kt">TransitionType</span> <span class="o">==</span> <span class="kt"><a href="../Structs/Transition.html">Transition</a></span><span class="o">&lt;</span><span class="kt"><a href="../Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorPAAE18RootViewControllera">RootViewController</a></span><span class="o">&gt;</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12XCoordinator11CoordinatorPAARlzCrlE12registerPeek3for5routeAA10TransitionVyqd__GAA9Container_p_9RouteTypeQztSo16UIViewControllerCRbd__AI0gJ0RtzlF"></a>
                    <a name="//apple_ref/swift/Method/registerPeek(for:route:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:12XCoordinator11CoordinatorPAARlzCrlE12registerPeek3for5routeAA10TransitionVyqd__GAA9Container_p_9RouteTypeQztSo16UIViewControllerCRbd__AI0gJ0RtzlF">registerPeek(for:route:)</a>
                    </code>
                      <span class="declaration-note">
                        Extension method
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Use this transition to register 3D Touch Peek and Pop functionality.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">@available(iOS, introduced: 9.0, deprecated: 13.0, message: "Use `UIContextMenuInteraction` instead.")</span>
<span class="kd">public</span> <span class="kd">func</span> <span class="n">registerPeek</span><span class="o">&lt;</span><span class="kt"><a href="../Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorPAAE18RootViewControllera">RootViewController</a></span><span class="o">&gt;</span><span class="p">(</span><span class="k">for</span> <span class="nv">source</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Container.html">Container</a></span><span class="p">,</span>
                                             <span class="nv">route</span><span class="p">:</span> <span class="kt">RouteType</span>
    <span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/Transition.html">Transition</a></span><span class="o">&lt;</span><span class="kt"><a href="../Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorPAAE18RootViewControllera">RootViewController</a></span><span class="o">&gt;</span> <span class="k">where</span> <span class="k">Self</span><span class="o">.</span><span class="kt">TransitionType</span> <span class="o">==</span> <span class="kt"><a href="../Structs/Transition.html">Transition</a></span><span class="o">&lt;</span><span class="kt"><a href="../Protocols/Coordinator.html#/s:12XCoordinator11CoordinatorPAAE18RootViewControllera">RootViewController</a></span><span class="o">&gt;</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>source</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The view to register peek and pop on.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>route</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The route to be triggered for peek and pop.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
          </div>
        </section>

      </article>
    </div>
    <section class="footer">
      <p>&copy; 2019 <a class="link" href="https://quickbirdstudios.com" target="_blank" rel="external">Stefan Kofler &amp; Paul Kraft</a>. All rights reserved. (Last updated: 2019-09-18)</p>
      <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
    </section>
  </body>
</div>
</html>
